TIP

Java 8 引入了一个很有趣的特性是 Optional 类。Optional 类主要解决的问题是臭名昭著的空指针异常（NullPointerException） —— 每个 Java 程序员都非常了解的异常。本质上，这是一个包含有可选值的包装类，这意味着 Optional 类既可以含有对象也可以为空。

Optional 是 Java 实现 函数式编程 的强劲一步，并且帮助在范式中实现。但是 Optional 的意义显然不止于此。

Java Optional类

NPE 问题

我们从一个简单的用例开始，在 Java 8 之前，任何访问对象方法或属性的调用都可能导致 NullPointerException：

java

String isocode = user.getAddress().getCountry().getIsocode().toUpperCase();

在这个小示例中，如果我们需要确保不触发异常，就得在访问每一个值之前对其进行明确地检查：

java

if (user != null) {
    Address address = user.getAddress();
    if (address != null) {
        Country country = address.getCountry();
        if (country != null) {
            String isocode = country.getIsocode();
            if (isocode != null) {
                isocode = isocode.toUpperCase();
            }
        }
    }
}

可以看到，代码很容易就变得冗长且难以维护。

为了简化这个过程，我们来看看用 Optional 类是怎么做的。

从创建和验证实例，到使用其不同的方法，并与其它返回相同类型的方法相结合，下面是见证 Optional 奇迹的时刻。

创建 Optional 实例

Optional(T value)，即构造方法，它是 private 权限的，不能由外部调用的。

empty()，of(T value)，ofNullable(T value) 这三个函数则是 public 权限的，可以供我们所调用。

那么，Optional的本质，就是内部储存了一个真实的值，在构造的时候，就直接判断其值是否为空。

Optional(T value) 方法的源码，如下图所示

of(T value) 的源码如下：

java

public static <T> Optional<T> of(T value) {
    return new Optional<>(value);
}

也就是说 of(T value) 方法内部调用了构造方法。

而根据构造方法的源码我们可以得出两个结论：

通过 of(T value) 函数所构造出的 Optional 对象，当 Value 值为空时，依然会报 NullPointerException。
通过 of(T value) 函数所构造出的 Optional 对象，当 Value 值不为空时，能正常构造 Optional 对象。

除此之外呢，Optional 类内部还维护一个 value 为 null 的对象，大概就是长下面这样的：

java

public final class Optional<T> {
    //省略....
    private static final Optional<?> EMPTY = new Optional<>();
    private Optional() {
        this.value = null;
    }
    //省略...
    public static<T> Optional<T> empty() {
        @SuppressWarnings("unchecked")
        Optional<T> t = (Optional<T>) EMPTY;
        return t;
    }
}

那么，empty() 的作用就是返回 EMPTY 对象。

好了铺垫了这么多，可以说 ofNullable(T value) 的作用了，上源码

java

public static <T> Optional<T> ofNullable(T value) {
    return value == null ? empty() : of(value);
}

对比 of(T value) 的源码来看，不难发现，当 value 值为 null 时，of(T value) 会报 NullPointerException 异常；

ofNullable(T value) 则不会 throw Exception，而是直接返回一个EMPTY 对象。

那是不是意味着，我们在项目中只用 ofNullable() 方法而不用 of() 方法呢?

其实并非如此，当我们需要代码在运行过程中，不隐藏 NullPointerException，而是立即报告的时候，这种情况下就用of()函数。

但是不得不承认，这样的场景真的很少。

返回默认值

Optional 类提供了 API 用以返回对象值，或者在对象为空的时候返回默认值。

这里你可以使用的第一个方法是 orElse(T other)，它的工作方式非常直接，如果有值则返回该值，否则返回传递给它的参数值：

java

@Test
public void whenEmptyValue_thenReturnDefault() {
    User user = null;
    User user2 = new User("anna@gmail.com", "1234");
    User result = Optional.ofNullable(user).orElse(user2);

    assertEquals(user2.getEmail(), result.getEmail());
}

这里 user 对象是空的，所以返回了作为默认值的 user2，如果对象的初始值不是 null，那么默认值会被忽略：

java

@Test
public void whenValueNotNull_thenIgnoreDefault() {
    User user = new User("john@gmail.com","1234");
    User user2 = new User("anna@gmail.com", "1234");
    User result = Optional.ofNullable(user).orElse(user2);

    assertEquals("john@gmail.com", result.getEmail());
}

第二个同类型的 API 是 orElseGet(Supplier other) —— 其行为略有不同。

这个方法会在有 user 对象的时候返回 user 对象，如果 user 对象是空的，它会执行作为参数传入的 Supplier(供应者)函数式接口，并将返回其执行结果：

java

User result = Optional.ofNullable(user).orElseGet( () -> user2);

orElse(T other) 和 orElseGet(Supplier other) 的不同之处

乍一看，这两种方法似乎作用完全相同，然而事实并非如此。

我们先来看看对象为空时他们的行为：

java

@Test
public void givenEmptyValue_whenCompare_thenOk() {
    User user = null
    logger.debug("Using orElse");
    User result = Optional.ofNullable(user).orElse(createNewUser());
    logger.debug("Using orElseGet");
    User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}

private User createNewUser() {
    logger.debug("Creating New User");
    return new User("extra@gmail.com", "1234");
}

上面的代码中，两种方法都调用了 createNewUser() 方法，这个方法会打印一个消息并返回 user 对象。

代码输出如下：

shell

Using orElse
Creating New User
Using orElseGet
Creating New User

由此可见，当 user 对象为空，所以返回默认对象时，行为并无差异。

我们接下来看一个类似的示例，但这里 user 对象不为空：

java

@Testpublic void givenPresentValue_whenCompare_thenOk() {
    User user = new User("john@gmail.com", "1234");
    logger.info("Using orElse");
    User result = Optional.ofNullable(user).orElse(createNewUser());
    logger.info("Using orElseGet");
    User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}

这次的输出：

shell

Using orElse
Creating New User
Using orElseGet

显然，在 user 对象非空的情况下，两个方法都会返回对应的非空值。

不过差别在于，orElse(T other) 方法仍然执行了 createNewUser() 方法，而 orElseGet(Supplier other) 方法并不会执行 createNewUser() 方法。

返回异常

Optional 还定义了 orElseThrow(Supplier exceptionSupplier)，它会在对象为空的时候抛出异常，而不是返回备选的值：

java

@Test
public void givenPresentValue_whenCompare_thenOk() {
    User user = new User("john@gmail.com", "1234");
    logger.info("Using orElse");
    User result = Optional.ofNullable(user).orElse(createNewUser());
    logger.info("Using orElseGet");
    User result2 = Optional.ofNullable(user).orElseGet(() -> createNewUser());
}

这里，如果 user 值为 null，会抛出 IllegalArgumentException。

这个方法让我们有更丰富的语义，可以决定抛出什么样的异常，而不总是抛出 NullPointerException。

转换值

有很多种方法可以转换 Optional 的值，我们从 map(Function mapper) 和 flatMap(Function> mapper) 方法开始。

直接上源码：

java

public final class Optional<T> {
    //省略....
    public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
        Objects.requireNonNull(mapper);
        if (!isPresent())
            return empty();
        else {
            return Optional.ofNullable(mapper.apply(value));
        }
    }
    //省略...
    public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
        Objects.requireNonNull(mapper);
        if (!isPresent())
            return empty();
        else {
            return Objects.requireNonNull(mapper.apply(value));
       }
   }
}

这两个函数，在函数体上没什么区别。唯一区别的就是入参，map() 函数所接受的入参类型为 Function<? super T, ? extends U>，而 flapMap() 的入参类型为 Function<? super T, Optional<U>>。

来看一个使用 map(Function mapper) 的例子：

java

@Test
public void whenMap_thenOk() {
    User user = new User("anna@gmail.com", "1234");
    String email = Optional.ofNullable(user).map(u -> u.getEmail()).orElse("default@gmail.com");

    assertEquals(email, user.getEmail());
}

map(Function mapper) 对值应用（调用）作为参数的函数，然后将返回的值包装在 Optional 中，这就使对返回值进行链试调用的操作成为可能 —— 这里的下一环就是 orElse()。

相比这下，flatMap(Function> mapper) 也需要函数作为参数，并对值调用这个函数，然后直接返回结果。

下面的操作中，我们给 User 类添加了一个方法，用来返回 Optional：

java

public class User {
    private String position;

    public Optional<String> getPosition() {
        return Optional.ofNullable(position);
    }

    //...
}

既然 getPosition() 方法返回 String 值的 Optional，你可以在对 user 的 Optional 对象调用 flatMap(Function> mapper) 时，用它作为参数，其返回的值是解除包装的 String 值：

java

@Test
public void whenFlatMap_thenOk() {
    User user = new User("anna@gmail.com", "1234");
    user.setPosition("Developer");
    String position = Optional.ofNullable(user).flatMap(u -> u.getPosition()).orElse("default");

    assertEquals(position, user.getPosition().get());
}

判空操作

isPresent() 即判断value值是否为空，而 ifPresent(Consumer consumer) 就是在 value 值不为空时，做一些操作。

这两个函数的源码如下：

java

public final class Optional<T> {
    //省略....
    public boolean isPresent() {
        return value != null;
    }
    //省略...
    public void ifPresent(Consumer<? super T> consumer) {
        if (value != null)
            consumer.accept(value);
    }
}

需要额外说明的是，大家千万不要把：

java

if (user != null){
   // TODO: do something
}

给写成：

java

User user = Optional.ofNullable(user);
if (Optional.isPresent()){
   // TODO: do something
}

因为这样写，代码结构依然很丑陋，正确写法是使用 ifPresent(Consumer<? super T> consumer)，用法也很简单，如下所示：

java

Optional.ofNullable(user).ifPresent(u->{
    // TODO: do something
});

过滤值

Optional 类也提供了按条件“过滤“值的方法 filter(Predicate predicate) 。

直接上源码：

java

public final class Optional<T> {
    //省略....
   Objects.requireNonNull(predicate);
        if (!isPresent())
            return this;
        else
            return predicate.test(value) ? this : empty();
}

filter(Predicate predicate) 方法接受一个 Predicate 来对 Optional 中包含的值进行过滤，如果包含的值满足条件，那么还是返回这个 Optional，否则返回 Optional.empty。

来看一个根据基本的电子邮箱验证来决定接受或拒绝 user 的示例：

java

@Test
public void whenFilter_thenOk() {
    User user = new User("anna@gmail.com", "1234");
    Optional<User> result = Optional.ofNullable(user)
      .filter(u -> u.getEmail() != null && u.getEmail().contains("@"));

    assertTrue(result.isPresent());
}

如果通过过滤器测试，result 对象会包含非空值。

访问 Optional 对象的值

从 Optional 实例中取回实际值对象的方法之一是使用 get() 方法：

java

@Test
public void whenCreateOfNullableOptional_thenOk() {
    String name = "John";
    Optional<String> opt = Optional.ofNullable(name);

    assertEquals("John", opt.get());
}

不过，你看到了，这个方法会在值为 null 的时候抛出异常。要避免异常，你可以选择首先验证是否有值：

java

@Test
public void whenCheckIfPresent_thenOk() {
    User user = new User("john@gmail.com", "1234");
    Optional<User> opt = Optional.ofNullable(user);
    assertTrue(opt.isPresent());

    assertEquals(user.getEmail(), opt.get().getEmail());
}

检查是否有值的另一个选择是 ifPresent() 方法。该方法除了执行检查，还接受一个 Consumer（消费者）参数，如果对象不是空的，就对执行传入的 Lambda 表达式：

java

opt.ifPresent( u -> assertEquals(user.getEmail(), u.getEmail()));

这个例子中，只有 user 用户不为 null 的时候才会执行断言。

Optional 类的链式方法

为了更充分的使用 Optional，你可以链接组合其大部分方法，因为它们都返回相同类似的对象。

我们使用 Optional 重写最早介绍的示例。

首先，重构类，使其 getter 方法返回 Optional 引用：

java

public class User {
    private Address address;

    public Optional<Address> getAddress() {
        return Optional.ofNullable(address);
    }

    // ...
}
public class Address {
    private Country country;

    public Optional<Country> getCountry() {
        return Optional.ofNullable(country);
    }

    // ...
}

上面的嵌套结构可以用下面的图来表示：

现在可以删除 null 检查，替换为 Optional 的方法：

java

@Test
public void whenChaining_thenOk() {
    User user = new User("anna@gmail.com", "1234");

    String result = Optional.ofNullable(user)
        .flatMap(u -> u.getAddress())
        .flatMap(a -> a.getCountry())
        .map(c -> c.getIsocode())
        .orElse("default");

    assertEquals(result, "default");
}

上面的代码可以通过方法引用进一步缩减：

java

String result = Optional.ofNullable(user)
    .flatMap(User::getAddress)
    .flatMap(Address::getCountry)
    .map(Country::getIsocode)
    .orElse("default");

结果现在的代码看起来比之前采用条件分支的冗长代码简洁多了。

Java 9 增强

我们介绍了 Java 8 的特性，Java 9 为 Optional 类添加了三个方法：or()、ifPresentOrElse() 和 stream()。

or() 方法与 orElse() 和 orElseGet() 类似，它们都在对象为空的时候提供了替代情况。

or() 的返回值是由 Supplier 参数产生的另一个 Optional 对象。

如果对象包含值，则 Lambda 表达式不会执行：

java

@Test
public void whenEmptyOptional_thenGetValueFromOr() {
    User result = Optional.ofNullable(user)
        .or( () -> Optional.of(new User("default","1234"))).get();

    assertEquals(result.getEmail(), "default");
}

上面的示例中，如果 user 变量是 null，它会返回一个 Optional，它所包含的 User 对象，其电子邮件为 “default”。

ifPresentOrElse() 方法需要两个参数：一个 Consumer 和一个 Runnable。如果对象包含值，会执行 Consumer 的动作，否则运行 Runnable。

如果你想在有值的时候执行某个动作，或者只是跟踪是否定义了某个值，那么这个方法非常有用：

java

Optional.ofNullable(user).ifPresentOrElse( u -> logger.info("User is:" + u.getEmail()),
                                          () -> logger.info("User not found"));

最后介绍的是新的 stream() 方法，它通过把实例转换为 Stream 对象，让你从广大的 Stream API 中受益。如果没有值，它会得到空的 Stream；有值的情况下，Stream 则会包含单一值。

我们来看一个把 Optional 处理成 Stream 的例子：

java

@Test
public void whenGetStream_thenOk() {
    User user = new User("john@gmail.com", "1234");
    List<String> emails = Optional.ofNullable(user)
      .stream()
      .filter(u -> u.getEmail() != null && u.getEmail().contains("@"))
      .map( u -> u.getEmail())
      .collect(Collectors.toList());

    assertTrue(emails.size() == 1);
    assertEquals(emails.get(0), user.getEmail());
}

这里对 Stream 的使用带来了其 filter()、map() 和 collect() 接口，以获取 List。

Optional 应该怎样用？

在使用 Optional 的时候需要考虑一些事情，以决定什么时候怎样使用它。

重要的一点是 Optional 不是 Serializable。因此，它不应该用作类的字段。

如果你需要序列化的对象包含 Optional 值，Jackson 库支持把 Optional 当作普通对象。也就是说，Jackson 会把空对象看作 null，而有值的对象则把其值看作对应域的值。这个功能在 jackson-modules-java8 项目中。

它在另一种情况下也并不怎么有用，就是在将其类型用作方法或构建方法的参数时。这样做会让代码变得复杂，完全没有必要：

java

User user = new User("john@gmail.com", "1234", Optional.empty());

使用重载方法来处理非要的参数要容易得多。

Optional 主要用作返回类型。在获取到这个类型的实例后，如果它有值，你可以取得这个值，否则可以进行一些替代行为。

Optional 类有一个非常有用的用例，就是将其与流或其它返回 Optional 的方法结合，以构建流畅的API。

我们来看一个示例，使用 Stream 返回 Optional 对象的 findFirst() 方法：

java

@Test
public void whenEmptyStream_thenReturnDefaultOptional() {
    List<User> users = new ArrayList<>();
    User user = users.stream().findFirst().orElse(new User("default", "1234"));

    assertEquals(user.getEmail(), "default");
}

总结

Optional 是 Java 语言的有益补充 —— 它旨在减少代码中的 NullPointerExceptions，虽然还不能完全消除这些异常。

它也是精心设计，自然融入 Java 8 函数式支持的功能。

总的来说，这个简单而强大的类有助于创建简单、可读性更强、比对应程序错误更少的程序。

Java Optional类 ​

NPE 问题 ​

创建 Optional 实例 ​

返回默认值 ​

orElse(T other) 和 orElseGet(Supplier other) 的不同之处 ​

返回异常 ​

转换值 ​

判空操作 ​

过滤值 ​

访问 Optional 对象的值 ​

Optional 类的链式方法 ​

Java 9 增强 ​

Optional 应该怎样用？ ​

总结 ​

Java Optional类

NPE 问题

创建 Optional 实例

返回默认值

orElse(T other) 和 orElseGet(Supplier other) 的不同之处

返回异常

转换值

判空操作

过滤值

访问 Optional 对象的值

Optional 类的链式方法

Java 9 增强

Optional 应该怎样用？

总结